EstuaryClient.AutoretrieveApi

All URIs are relative to https://api.estuary.tech

Method	HTTP request	Description
adminAutoretrieveInitPost	POST /admin/autoretrieve/init	Register autoretrieve server
adminAutoretrieveListGet	GET /admin/autoretrieve/list	List autoretrieve servers
autoretrieveHeartbeatPost	POST /autoretrieve/heartbeat	Marks autoretrieve server as up

# **adminAutoretrieveInitPost** > adminAutoretrieveInitPost(addresses, pubKey)

Register autoretrieve server

This endpoint registers a new autoretrieve server

Example

var EstuaryClient = require('estuary-client');
var defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

var apiInstance = new EstuaryClient.AutoretrieveApi();

var addresses = "addresses_example"; // String | Autoretrieve's comma-separated list of addresses

var pubKey = "pubKey_example"; // String | Autoretrieve's public key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.adminAutoretrieveInitPost(addresses, pubKey, callback);

Parameters

Name	Type	Description	Notes
addresses	String	Autoretrieve's comma-separated list of addresses
pubKey	String	Autoretrieve's public key

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

# **adminAutoretrieveListGet** > adminAutoretrieveListGet()

List autoretrieve servers

This endpoint lists all registered autoretrieve servers

Example

var EstuaryClient = require('estuary-client');
var defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

var apiInstance = new EstuaryClient.AutoretrieveApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.adminAutoretrieveListGet(callback);

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

# **autoretrieveHeartbeatPost** > autoretrieveHeartbeatPost(token)

Marks autoretrieve server as up

This endpoint updates the lastConnection field for autoretrieve

Example

var EstuaryClient = require('estuary-client');
var defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

var apiInstance = new EstuaryClient.AutoretrieveApi();

var token = "token_example"; // String | Autoretrieve's auth token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.autoretrieveHeartbeatPost(token, callback);

Parameters

Name	Type	Description	Notes
token	String	Autoretrieve's auth token

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json